This repository has been archived by the owner on Feb 26, 2024. It is now read-only.
Restrict general help content in REPL context #5885
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cds-amal
commented
Feb 12, 2023
|
|
||
| // Create an expression that returns a string when evaluated | ||
| // by the REPL | ||
| const makeIIFE = str => `(() => "${str}")()`; | ||
|
|
||
| const processInput = (input, allowedCommands) => { | ||
| const processInput = input => { |
There was a problem hiding this comment.
While working this PR I was tempted to refactor REPL input processing because it is all over the place, misnamed and should be consolidated. I'll add an issue for that.
cds-amal
changed the title
- help in console REPLS will only be constrained to allowed console commands - maintain a list of valid console commands instead of calculating
- simplifies the console class. - changes error output in console/repl
I have to say I don't see how that's a breaking change. |
haltman-at
reviewed
Feb 14, 2023
haltman-at
approved these changes
Feb 15, 2023
There was a problem hiding this comment.
Makes sense to me. What was that getCommand doing there, I wonder? (Actually, I'd bet it was the older code and then the guard was later added before it. Hm... did the guard break using abbreviated commands at the console? Oh well, nobody's complained about it...)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR description
This PR limits the general help output for
truffle consoleandtruffle developso help forconsole,dashboard,db,develop,initandwatchwon't be shown. It achieves this by defining a single source of truth for valid CLI and Console commands. Thecommands/commands.jsmodule defines this state, and other parts of the codebase have been refactored to import and rely on this information. The Console class no longer needs to be passedallowedCommandsand has removed the maintenance ofexcludedCommands. Instead, the signature for the help function has changed to indicate whether it is displaying help for the CLI or the REPL. Tests and webpack concerns have been updated to reflect these changes, and the source of truth for valid Truffle commands has been updated in various files.Contributes to: #5312
Testing instructions
helpin truffle develop, and confirm it doesn't show help forconsole,dashboard,db,develop,initandwatchDocumentation & breaking changes concerns